/*
 * Copyright 2010 Biz-e (info@biz-e.nl)
 * 
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 * http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package nl.biz_e.acl.client.data;

import java.util.Vector;

/**
 * Abstract event routing implementation
 * 
 * @author Joost A. Bloemsma
 * 
 */
public abstract class AbstractController {
	protected Vector<ControllerEventListener> listeners = new Vector<ControllerEventListener>();
	
	/**
	 * Adds a {@link ControllerEventListener} to this controller
	 * 
	 * @param listener
	 */
	public void addListener(ControllerEventListener listener) {
		if (!listeners.contains(listener))
			listeners.add(listener);
	}
	
	/**
	 * Removes a {@link ControllerEventListener} from this controller
	 * 
	 * @param listener
	 */
	public void removeListener(ControllerEventListener listener) {
		listeners.remove(listener);
	}
	
	/**
	 * Event passed to listeners
	 * 
	 */
	public class ControllerEvent {
		/**
		 * Constructs a new ControllerEvent instance
		 */
		public ControllerEvent() {
			super();
		}
	}
	
	/**
	 * Notifies registered listeners of an event
	 * 
	 * @param e
	 */
	public void notify(ControllerEvent e) {
		for (ControllerEventListener listener : listeners) {
			listener.onEvent(e);
		}
	}
	
	/**
	 * Interface to be implemented by listeners
	 */
	public interface ControllerEventListener {
		/**
		 * Will be fired by this controller if an event occurs
		 * 
		 * @param e
		 */
		public void onEvent(ControllerEvent e);
	}
}
